Export a Theme

{ exportTheme }

Exports an existing theme definition to a 'PAT' file.

Method

/API3/themes/exportTheme

  • API Section: /API3/themes
  • API Version: 3.0
  • From Release: 2023.10
  • Can be used by all user types
  • REST API and Client SDK libraries. REST APIs via POST actions only.
    • Input Parameters

    Name

    themeId

    Type

    string

    Description

    The theme's system ID

    Output Response

    Successful Result Code

    200

    Response Type

    ExportData

    Description of Response Type

    The object representing the exported PIE file.

    Notes

    Use this API method to export a theme definition to be re-imported to another Pyramid instance

    Code Snippets

    JavaScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/themes/exportTheme" \
 -d ''

    import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.ThemesServiceApi;

import java.util.*;

public class ThemesServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ThemesServiceApi apiInstance = new ThemesServiceApi();
        // Initialize the themeId parameter object for the call
        String themeId = themeId_example; // String | 

        try {
            ExportData result = apiInstance.exportTheme(themeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThemesServiceApi#exportTheme");
            e.printStackTrace();
        }
    }
}

    const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;

// Configure API key authorization: paToken
const paToken = defaultClient.authentications['paToken'];
paToken.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.apiKeyPrefix['paToken'] = "Token";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.ThemesServiceApi("http://Your.Server.URL")
const themeId = themeId_example; // {String} 

const callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportTheme(themeId, callback);

    using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class exportThemeExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new ThemesServiceApi();
        // Initialize the themeId parameter object for the call
        var themeId = themeId_example;  // String | 

        try {
            // Exports an existing theme definition to a 'PAT' file.
            ExportData result = apiInstance.exportTheme(themeId);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling ThemesServiceApi.exportTheme: " + e.Message );
        }
    }
}


    import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from pprint import pprint


# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# api_config.api_key_prefix['paToken'] = 'Bearer'

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = com.pyramidanalytics.ThemesServiceApi(api_client)
    # Initialize the themeId parameter object for the call
    themeId = themeId_example # String | 

    try:
        # Exports an existing theme definition to a 'PAT' file.
        api_response = api_instance.export_theme(themeId)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ThemesServiceApi->exportTheme: %s\n" % e)
    <?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ThemesServiceApi();
$themeId = themeId_example; // String | 

try {
    $result = $api_instance->exportTheme($themeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ThemesServiceApi->exportTheme: ', $e->getMessage(), PHP_EOL;
}
?>

    Note: Use the 'Authentication' API methods to generate an access 'key' or 'token'.